Hybris UX Api

Update Order Details for the PR market

This API is used to update the technician appointment for particular Order.

GET /searchTimeSlot API should be executed before updating the appointment to get the available technician's timeslot.

Request

This section defines all the possible data structures sent by the client when consuming the method.

URL

https://[localhost]:[port]/ecom-ux/v1/PR/appointment/{id}

URL PARAMS

Header

Mandatory Fields

OrderReasonCode, CampaignCode, JobType, RescheduleReason, orderId.

note Subresource in Request

Patch AppointmentById Request Body for PR Market:

{
    "validFor": {
        "startDateTime": "2023-10-05T08:00:00.000-04:00",
        "endDateTime": "2023-10-05T12:00:00.000-04:00"
    },
    "relatedParty": [
        {
            "role": "Technician",
            "id": "1000",
            "@referredType": "Technician"
        },
        {
            "role": "Sales Representative",
            "id": "54321",
            "@referredType": "SalesRepresentative"
        }
    ],
    "relatedEntity": [
        {
            "id": "1200052247691014",
            "name": "orderId"
        }
    ],
    "note": [
        {
            "text": "E1",
            "@type": "OrderReasonCode"
        },
        {
            "text": "ECO",
            "@type": "CampaignCode"
        },
        {
            "text": "NC",
            "@type": "JobType"
        },
        {
            "text": "CR",
            "@type": "RescheduleReason"
        }
    ]
}

Definitions

Each of the request parameters is detailed.

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 200 ]

Created - Resource created successfully, response body contains an entity corresponding to the requested resource.

{
    "id": "12000522476910140001",
    "status": "R",
    "externalId": "112368",
    "validFor": {
        "startDateTime": "2023-10-05T08:00:00.071-04:00",
        "endDateTime": "2023-10-05T12:00:00.071-04:00"
    },
    "relatedParty": [
        {
            "role": "Technician",
            "id": "1000",
            "@referredType": "Technician"
        },
        {
            "role": "Sales Representative",
            "id": "54321",
            "@referredType": "Sales Representative"
        }
    ],
    "relatedEntity": [
        {
            "id": "1200052247691014",
            "name": "OrderID"
        }
    ],
    "note": [
        {
            "id": "E1",
            "name": "OrderReasonCode"
        },
        {
            "id": "ECO",
            "name": "CampaignCode"
        },
        {
            "id": "NC",
            "name": "JobType"
        },
        {
            "id": "CR",
            "name": "RescheduleReason"
        },
        {
            "id": "001",
            "name": "TotalUnits"
        }
    ]
}

Possible Status Code

Possible RescheduleReason Values

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
  "errors" : [{
      "code" : 400 ,
      "message" : "The request is invalid or not properly formed.",
      "description" : "The client sent too many requests and server is not able to serve them all at the moment"
    }
  ]
}

[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
  "errors" : [{
      "code" : 501,
      "message" : "NOT IMPLEMENTED",
      "description" : "Operation GET /reset for Business Id: PR not implemented"
    }
  ]
  }